NAVNavbar
Logo
cURL php NodeJS Python cSharp

Subdomains

‌‌
This endpoint will provide you with a list of subdomains of the specified domain, along with the ranking distribution across organic and paid search. In addition to that, you will also get the estimated traffic volume of subdomains based on search volume and impressions.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
	"target" => "dataforseo.com",
	"language_name" => "English",
	"location_code" => 2840,
	"filters" => [
		["metrics.organic.pos_1", "<>", 0],
		"or",
		["metrics.organic.pos_2_3", "<>", 0]
	]
);
try {
   // POST /v3/dataforseo_labs/google/subdomains/live
   $result = $client->post('/v3/dataforseo_labs/google/subdomains/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20240514",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.1664 sec.",
  "cost": 0.0101,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "06131916-1535-0384-0000-dbdae2640969",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.1108 sec.",
      "cost": 0.0101,
      "result_count": 1,
      "path": [
        "v3",
        "dataforseo_labs",
        "google",
        "subdomains",
        "live"
      ],
      "data": {
        "api": "dataforseo_labs",
        "function": "subdomains",
        "se_type": "google",
        "target": "dataforseo.com",
        "language_name": "English",
        "location_code": 2840,
        "filters": [
          [
            "metrics.organic.pos_1",
            "<>",
            0
          ],
          "or",
          [
            "metrics.organic.pos_2_3",
            "<>",
            0
          ]
        ]
      },
      "result": [
        {
          "se_type": "google",
          "target": "dataforseo.com",
          "location_code": 2840,
          "language_code": "en",
          "total_count": 1,
          "items_count": 1,
          "items": [
            {
              "se_type": "google",
              "subdomain": "dataforseo.com",
              "metrics": {
                "organic": {
                  "pos_1": 22,
                  "pos_2_3": 26,
                  "pos_4_10": 353,
                  "pos_11_20": 579,
                  "pos_21_30": 386,
                  "pos_31_40": 333,
                  "pos_41_50": 317,
                  "pos_51_60": 273,
                  "pos_61_70": 290,
                  "pos_71_80": 256,
                  "pos_81_90": 217,
                  "pos_91_100": 200,
                  "etv": 16830.186164559796,
                  "impressions_etv": 572.4957387289032,
                  "count": 3252,
                  "estimated_paid_traffic_cost": 79709.50598598632,
                  "is_new": 919,
                  "is_up": 1441,
                  "is_down": 739,
                  "is_lost": 0,
                  "clickstream_etv": 630.3387209999999,
                  "clickstream_gender_distribution": {
                    "female": 34,
                    "male": 65
                  },
                  "clickstream_age_distribution": {
                    "18-24": 12,
                    "25-34": 37,
                    "35-44": 41,
                    "45-54": 7,
                    "55-64": 0
                  }
                },
                "paid": {
                  "pos_1": 11,
                  "pos_2_3": 5,
                  "pos_4_10": 1,
                  "pos_11_20": 0,
                  "pos_21_30": 0,
                  "pos_31_40": 0,
                  "pos_41_50": 0,
                  "pos_51_60": 0,
                  "pos_61_70": 0,
                  "pos_71_80": 0,
                  "pos_81_90": 0,
                  "pos_91_100": 0,
                  "etv": 424.47499722242355,
                  "impressions_etv": 72.0459917485714,
                  "count": 17,
                  "estimated_paid_traffic_cost": 3248.2200407981873,
                  "is_new": 15,
                  "is_up": 0,
                  "is_down": 1,
                  "is_lost": 0,
                  "clickstream_etv": 271.27529999999996,
                  "clickstream_gender_distribution": {
                    "female": 38,
                    "male": 61
                  },
                  "clickstream_age_distribution": {
                    "18-24": 0,
                    "25-34": 58,
                    "35-44": 41,
                    "45-54": 0,
                    "55-64": 0
                  }
                },
                "featured_snippet": null,
                "local_pack": null
              }
            }
          ]
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute. The maximum number of requests that can be sent simultaneously is limited to 30.

You can specify the number of results you want to retrieve, filter and sort them.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
target string domain
required field
the domain name of the target website
the domain should be specified without https:// and www.
location_name string full name of the location
optional field
if you use this field, you don’t need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
United Kingdom
location_code integer location code
optional field
if you use this field, you don’t need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
2840
language_name string full name of the language
optional field
if you use this field, you don’t need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
English
language_code string language code
optional field
if you use this field, you don’t need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
en
item_types array display results by item type
optional field
indicates the type of search results included in the response

Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;

possible values:
["organic", "paid", "featured_snippet", "local_pack"]
default value:
["organic", "paid"]

include_clickstream_data boolean include or exclude data from clickstream-based metrics in the result
optional field
if the parameter is set to true, you will receive clickstream_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response
default value: false
with this parameter enabled, you will be charged double the price for the request

learn more about how clickstream-based metrics are calculated in this help center article

historical_serp_mode string data collection mode
optional field
you can use this field to filter the results;
possible types of filtering:
live — return metrics for SERPs in which the specified target currently has ranking results;
lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check;
all — return metrics for both types of SERPs.
default value: live
filters array array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:
regex, not_regex, <, <=, >, >=, =, <>, in, not_in
example:
["metrics.paid.count",">",0]

[["metrics.paid.count",">",0],"and",["metrics.paid.etv",">","50"]]

[["metrics.organic.count",">","10"],
"and",
[["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]

for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide

order_by array results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:
asc – results will be sorted in the ascending order
desc – results will be sorted in the descending order
you should use a comma to specify a sorting type
example:
["metrics.paid.etv,asc"]
Note: you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:
["metrics.organic.etv,desc","metrics.paid.count,asc"]

default rule:
["metrics.organic.count,desc"]
Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array

limit integer the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000
offset integer offset in the results array of returned keywords
optional field
default value: 0
if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
tag string user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response

As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            se_type string search engine type
            target string domain in a POST array
            location_code integer location code in a POST array
            language_code string language code in a POST array
            total_count integer total amount of results in our database relevant to your request
            items_count integer the number of results returned in the items array
            items array contains subdomains and related data
                se_type string search engine type
                subdomain string returned subdomain
                metrics object ranking data relevant to subdomain
                    organic object ranking and traffic data from organic search
                       pos_1 integer number of organic SERPs where the domain ranks #1
                       pos_2_3 integer number of organic SERPs where the domain ranks #2-3
                       pos_4_10 integer number of organic SERPs where the domain ranks #4-10
                       pos_11_20 integer number of organic SERPs where the domain ranks #11-20
                       pos_21_30 integer number of organic SERPs where the domain ranks #21-30
                       pos_31_40 integer number of organic SERPs where the domain ranks #31-40
                       pos_41_50 integer number of organic SERPs where the domain ranks #41-50
                       pos_51_60 integer number of organic SERPs where the domain ranks #51-60
                       pos_61_70 integer number of organic SERPs where the domain ranks #61-70
                       pos_71_80 integer number of organic SERPs where the domain ranks #71-80
                       pos_81_90 integer number of organic SERPs where the domain ranks #81-90
                       pos_91_100 integer number of organic SERPs where the domain ranks #91-100
                       etv float estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       impressions_etv float estimated traffic volume based on impressions
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       count integer total count of organic SERPs that contain the domain
                       estimated_paid_traffic_cost float estimated cost of converting organic search traffic into paid
represents the estimated monthly cost (USD) of running ads for all keywords in the category that a domain ranks for
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article
                       is_new integer number of new ranked elements
indicates how many new ranked elements were found for the indicated target
                       is_up integer rank went up
indicates how many ranked elements of the indicated target went up
                       is_down integer rank went down
indicates how many ranked elements of the indicated target went down
                       is_lost integer lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
                       clickstream_etv integer estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                       clickstream_gender_distribution object distribution of estimated clickstream-based metrics by gender
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           female integer number of female users in the relevant clickstream dataset
                           male integer number of male users in the relevant clickstream dataset
                       clickstream_age_distribution object distribution of clickstream-based metrics by age
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           18-24 integer number of users in the relevant clickstream dataset that fall within the 18-24 age range
                           25-34 integer number of users in the relevant clickstream dataset that fall within the 25-34 age range
                           35-44 integer number of users in the relevant clickstream dataset that fall within the 35-44 age range
                           45-54 integer number of users in the relevant clickstream dataset that fall within the 45-54 age range
                           55-64 integer number of users in the relevant clickstream dataset that fall within the 55-64 age range
                    paid object ranking and traffic data from paid search
                       pos_1 integer number of paid SERPs where the domain ranks #1
                       pos_2_3 integer number of paid SERPs where the domain ranks #2-3
                       pos_4_10 integer number of paid SERPs where the domain ranks #4-10
                       pos_11_20 integer number of paid SERPs where the domain ranks #11-20
                       pos_21_30 integer number of paid SERPs where the domain ranks #21-30
                       pos_31_40 integer number of paid SERPs where the domain ranks #31-40
                       pos_41_50 integer number of paid SERPs where the domain ranks #41-50
                       pos_51_60 integer number of paid SERPs where the domain ranks #51-60
                       pos_61_70 integer number of paid SERPs where the domain ranks #61-70
                       pos_71_80 integer number of paid SERPs where the domain ranks #71-80
                       pos_81_90 integer number of paid SERPs where the domain ranks #81-90
                       pos_91_100 integer number of paid SERPs where the domain ranks #91-100
                       etv float estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       impressions_etv float estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       count integer total count of paid SERPs that contain the domain
                       estimated_paid_traffic_cost float estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       is_new integer number of new ranked elements
indicates how many new ranked elements were found for the indicated target
                       is_up integer rank went up
indicates how many ranked elements of the indicated target went up
                       is_down integer rank went down
indicates how many ranked elements of the indicated target went down
                       is_lost integer lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
                       clickstream_etv integer estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                       clickstream_gender_distribution object distribution of estimated clickstream-based metrics by gender
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           female integer number of female users in the relevant clickstream dataset
                           male integer number of male users in the relevant clickstream dataset
                       clickstream_age_distribution object distribution of clickstream-based metrics by age
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           18-24 integer number of users in the relevant clickstream dataset that fall within the 18-24 age range
                           25-34 integer number of users in the relevant clickstream dataset that fall within the 25-34 age range
                           35-44 integer number of users in the relevant clickstream dataset that fall within the 35-44 age range
                           45-54 integer number of users in the relevant clickstream dataset that fall within the 45-54 age range
                           55-64 integer number of users in the relevant clickstream dataset that fall within the 55-64 age range
                    featured_snippet object ranking and traffic data from the featured snippet results in Google SERP
                       pos_1 integer number of featured snippet items where the domain ranks #1
                       pos_2_3 integer number of featured snippet items where the domain ranks #2-3
                       pos_4_10 integer number of featured snippet items where the domain ranks #4-10
                       pos_11_20 integer number of featured snippet items where the domain ranks #11-20
                       pos_21_30 integer number of featured snippet items where the domain ranks #21-30
                       pos_31_40 integer number of featured snippet items where the domain ranks #31-40
                       pos_41_50 integer number of featured snippet items where the domain ranks #41-50
                       pos_51_60 integer number of featured snippet items where the domain ranks #51-60
                       pos_61_70 integer number of featured snippet items where the domain ranks #61-70
                       pos_71_80 integer number of featured snippet items where the domain ranks #71-80
                       pos_81_90 integer number of featured snippet items where the domain ranks #81-90
                       pos_91_100 integer number of featured snippet items where the domain ranks #91-100
                       etv float estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       impressions_etv float estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       count integer total count of featured snippet items that contain the domain
                       estimated_paid_traffic_cost float estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       is_new integer number of new ranked elements
indicates how many new ranked elements were found for the indicated target
                       is_up integer rank went up
indicates how many ranked elements of the indicated target went up
                       is_down integer rank went down
indicates how many ranked elements of the indicated target went down
                       is_lost integer lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
                       clickstream_etv integer estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                       clickstream_gender_distribution object distribution of estimated clickstream-based metrics by gender
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           female integer number of female users in the relevant clickstream dataset
                           male integer number of male users in the relevant clickstream dataset
                       clickstream_age_distribution object distribution of clickstream-based metrics by age
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           18-24 integer number of users in the relevant clickstream dataset that fall within the 18-24 age range
                           25-34 integer number of users in the relevant clickstream dataset that fall within the 25-34 age range
                           35-44 integer number of users in the relevant clickstream dataset that fall within the 35-44 age range
                           45-54 integer number of users in the relevant clickstream dataset that fall within the 45-54 age range
                           55-64 integer number of users in the relevant clickstream dataset that fall within the 55-64 age range
                    local_pack object ranking and traffic data from the local pack results in SERP
                       pos_1 integer number of local pack items where the domain ranks #1
                       pos_2_3 integer number of local pack items where the domain ranks #2-3
                       pos_4_10 integer number of local pack items where the domain ranks #4-10
                       pos_11_20 integer number of local pack items where the domain ranks #11-20
                       pos_21_30 integer number of local pack items where the domain ranks #21-30
                       pos_31_40 integer number of local pack items where the domain ranks #31-40
                       pos_41_50 integer number of local pack items where the domain ranks #41-50
                       pos_51_60 integer number of local pack items where the domain ranks #51-60
                       pos_61_70 integer number of local pack items where the domain ranks #61-70
                       pos_71_80 integer number of local pack items where the domain ranks #71-80
                       pos_81_90 integer number of local pack items where the domain ranks #81-90
                       pos_91_100 integer number of local pack items where the domain ranks #91-100
                       etv float estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       impressions_etv float estimated traffic volume based on impressions
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and impressions values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       count integer total count of local pack items that contain the domain
                       estimated_paid_traffic_cost float estimated cost of monthly search traffic
represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                       is_new integer number of new ranked elements
indicates how many new ranked elements were found for the indicated target
                       is_up integer rank went up
indicates how many ranked elements of the indicated target went up
                       is_down integer rank went down
indicates how many ranked elements of the indicated target went down
                       is_lost integer lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren’t found during the last check
                       clickstream_etv integer estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                       clickstream_gender_distribution object distribution of estimated clickstream-based metrics by gender
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           female integer number of female users in the relevant clickstream dataset
                           male integer number of male users in the relevant clickstream dataset
                       clickstream_age_distribution object distribution of clickstream-based metrics by age
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article
                           18-24 integer number of users in the relevant clickstream dataset that fall within the 18-24 age range
                           25-34 integer number of users in the relevant clickstream dataset that fall within the 25-34 age range
                           35-44 integer number of users in the relevant clickstream dataset that fall within the 35-44 age range
                           45-54 integer number of users in the relevant clickstream dataset that fall within the 45-54 age range
                           55-64 integer number of users in the relevant clickstream dataset that fall within the 55-64 age range

‌‌